ci(release): derive release notes from CHANGELOG.md (single source of truth)#52
Merged
ci(release): derive release notes from CHANGELOG.md (single source of truth)#52
Conversation
Previously `release.yml` ran `gh release create --generate-notes`, which
produces GitHub's raw PR-list auto-summary. OpenSSF BestPractices
`release_notes` explicitly disqualifies that form — release notes must
be a human-readable curated summary of major changes and upgrade impact.
This ties the release workflow to CHANGELOG.md as the single source:
1. After artifact download, a new "Resolve release notes" step:
- Looks for `## [vX.Y.Z]` or `## [X.Y.Z]` in CHANGELOG.md.
- If missing, promotes non-empty `## [Unreleased]` → `## [X.Y.Z] — <today>`,
inserts a fresh `## [Unreleased]` above it, commits the rename to
main as github-actions[bot], and re-extracts.
- If neither [Unreleased] nor [X.Y.Z] have content, fails with a
clear instruction to populate CHANGELOG.md.
- Emits the extracted section as a multi-line step output.
2. The "Create GitHub release" step consumes that output via
`--notes-file` (prepended to the existing cosign Verify footer).
The old draft-then-edit dance is gone.
CHANGELOG.md gets a short contributor note explaining the flow so the
promotion is discoverable.
One acceptable consequence: the binary's embedded Commit SHA refers to
the pre-rename commit (github.sha captured by the build job), while the
tag points to the post-rename commit. The binary bytes are unaffected;
only the CHANGELOG.md doc differs.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2 tasks
aksOps
added a commit
that referenced
this pull request
Apr 23, 2026
…ation at CHANGELOG.md (#53) - README.md: add BestPractices badge (project 12628) next to the Security Scan + OpenSSF Score badges. - .bestpractices.json: release_notes_justification now points at the curated CHANGELOG.md (the single source of truth after PR #51/#52), not the raw-PR-list GitHub releases page. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Merged
7 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Wires CHANGELOG.md into the release workflow as the single source of truth for release notes. Replaces `--generate-notes` (raw PR list — disqualified by OpenSSF BestPractices `release_notes`) with curated content extracted from the CHANGELOG.
Contributor workflow
Implementation
New step: `Resolve release notes from CHANGELOG.md` (runs after `download-artifact`):
Modified step: `Create GitHub release` — now writes `release-notes.md` from the extracted body + the existing cosign Verify footer, and passes it via `--notes-file`. Removes the draft-then-edit dance.
CHANGELOG.md — adds a contributor note at the top explaining the promotion flow so it's discoverable without reading release.yml.
Consequences
Test plan
🤖 Generated with Claude Code